<!-- HTML header for doxygen 1.8.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: MemoryGroupBase&lt; TensorType &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Compute Library
   &#160;<span id="projectnumber">18.03</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.xhtml"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classarm__compute_1_1_memory_group_base.xhtml','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">MemoryGroupBase&lt; TensorType &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> group.  
 <a href="classarm__compute_1_1_memory_group_base.xhtml#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_c_l_tensor_allocator_8h_source.xhtml">CLTensorAllocator.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for MemoryGroupBase&lt; TensorType &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_memory_group_base__coll__graph.svg" width="255" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a65925c6cf4ee7a89e05557dfb2138c47"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a65925c6cf4ee7a89e05557dfb2138c47">MemoryGroupBase</a> (std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> &gt; memory_manager=nullptr)</td></tr>
<tr class="memdesc:a65925c6cf4ee7a89e05557dfb2138c47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#a65925c6cf4ee7a89e05557dfb2138c47">More...</a><br /></td></tr>
<tr class="separator:a65925c6cf4ee7a89e05557dfb2138c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa4d42fbf7f8e750b0b06994bcdf138c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#afa4d42fbf7f8e750b0b06994bcdf138c">~MemoryGroupBase</a> ()=default</td></tr>
<tr class="memdesc:afa4d42fbf7f8e750b0b06994bcdf138c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#afa4d42fbf7f8e750b0b06994bcdf138c">More...</a><br /></td></tr>
<tr class="separator:afa4d42fbf7f8e750b0b06994bcdf138c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3bab8638aeb3620e242dac72a1a1fda"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#af3bab8638aeb3620e242dac72a1a1fda">MemoryGroupBase</a> (const <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> &amp;)=delete</td></tr>
<tr class="memdesc:af3bab8638aeb3620e242dac72a1a1fda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#af3bab8638aeb3620e242dac72a1a1fda">More...</a><br /></td></tr>
<tr class="separator:af3bab8638aeb3620e242dac72a1a1fda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a597892bd64122315e3329751f634c20e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a597892bd64122315e3329751f634c20e">operator=</a> (const <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> &amp;)=delete</td></tr>
<tr class="memdesc:a597892bd64122315e3329751f634c20e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copy assigned (As this class contains pointers).  <a href="#a597892bd64122315e3329751f634c20e">More...</a><br /></td></tr>
<tr class="separator:a597892bd64122315e3329751f634c20e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adae764eb11b49e048bbd57b023caf402"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#adae764eb11b49e048bbd57b023caf402">MemoryGroupBase</a> (<a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:adae764eb11b49e048bbd57b023caf402"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#adae764eb11b49e048bbd57b023caf402">More...</a><br /></td></tr>
<tr class="separator:adae764eb11b49e048bbd57b023caf402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdceaca325dbcee01e9abebd2e4586dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#acdceaca325dbcee01e9abebd2e4586dc">operator=</a> (<a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:acdceaca325dbcee01e9abebd2e4586dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#acdceaca325dbcee01e9abebd2e4586dc">More...</a><br /></td></tr>
<tr class="separator:acdceaca325dbcee01e9abebd2e4586dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1f67376afb7822f262a0174ef4a3104"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#ac1f67376afb7822f262a0174ef4a3104">manage</a> (TensorType *obj)</td></tr>
<tr class="memdesc:ac1f67376afb7822f262a0174ef4a3104"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a object to be managed by the given memory group.  <a href="#ac1f67376afb7822f262a0174ef4a3104">More...</a><br /></td></tr>
<tr class="separator:ac1f67376afb7822f262a0174ef4a3104"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acea32c3a891a609580e97b9056b3cdf5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#acea32c3a891a609580e97b9056b3cdf5">finalize_memory</a> (TensorType *obj, void **handle, size_t <a class="el" href="hwc_8hpp.xhtml#ab2c6b258f02add8fdf4cfc7c371dd772">size</a>)</td></tr>
<tr class="memdesc:acea32c3a891a609580e97b9056b3cdf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalizes memory for a given object.  <a href="#acea32c3a891a609580e97b9056b3cdf5">More...</a><br /></td></tr>
<tr class="separator:acea32c3a891a609580e97b9056b3cdf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d16047fa6fdcf5f5453056cc0e1daba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">acquire</a> () override</td></tr>
<tr class="memdesc:a8d16047fa6fdcf5f5453056cc0e1daba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquires backing memory for the whole group.  <a href="#a8d16047fa6fdcf5f5453056cc0e1daba">More...</a><br /></td></tr>
<tr class="separator:a8d16047fa6fdcf5f5453056cc0e1daba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7ed3842c3160ae4b9f51acbf4564438"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">release</a> () override</td></tr>
<tr class="memdesc:ad7ed3842c3160ae4b9f51acbf4564438"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases backing memory of the whole group.  <a href="#ad7ed3842c3160ae4b9f51acbf4564438">More...</a><br /></td></tr>
<tr class="separator:ad7ed3842c3160ae4b9f51acbf4564438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a9171fb9c729a0a08b1d0ff3a5e3309"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#a762c7da7319adcc433b3ac7a67e18ed5">MemoryMappings</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309">mappings</a> () override</td></tr>
<tr class="memdesc:a0a9171fb9c729a0a08b1d0ff3a5e3309"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the memory mapping of the group.  <a href="#a0a9171fb9c729a0a08b1d0ff3a5e3309">More...</a><br /></td></tr>
<tr class="separator:a0a9171fb9c729a0a08b1d0ff3a5e3309"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classarm__compute_1_1_i_memory_group"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_memory_group')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_memory_group.xhtml">IMemoryGroup</a></td></tr>
<tr class="memitem:a9bd7b2a6304e2332de8a1fcfefb0111e inherit pub_methods_classarm__compute_1_1_i_memory_group"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_group.xhtml#a9bd7b2a6304e2332de8a1fcfefb0111e">~IMemoryGroup</a> ()=default</td></tr>
<tr class="memdesc:a9bd7b2a6304e2332de8a1fcfefb0111e inherit pub_methods_classarm__compute_1_1_i_memory_group"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a9bd7b2a6304e2332de8a1fcfefb0111e">More...</a><br /></td></tr>
<tr class="separator:a9bd7b2a6304e2332de8a1fcfefb0111e inherit pub_methods_classarm__compute_1_1_i_memory_group"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename TensorType&gt;<br />
class arm_compute::MemoryGroupBase&lt; TensorType &gt;</h3>

<p><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> group. </p>

<p>Definition at line <a class="el" href="_c_l_tensor_allocator_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_c_l_tensor_allocator_8h_source.xhtml">CLTensorAllocator.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a65925c6cf4ee7a89e05557dfb2138c47"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> &gt;&#160;</td>
          <td class="paramname"><em>memory_manager</em> = <code>nullptr</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default Constructor. </p>

<p>Definition at line <a class="el" href="_memory_group_base_8h_source.xhtml#l00087">87</a> of file <a class="el" href="_memory_group_base_8h_source.xhtml">MemoryGroupBase.h</a>.</p>

<p>References <a class="el" href="core_2_error_8h_source.xhtml#l00306">ARM_COMPUTE_ERROR_ON</a>.</p>
<div class="fragment"><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    : _memory_manager(std::move(memory_manager)), _pool(<span class="keyword">nullptr</span>), _mappings()</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;{</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <span class="keywordflow">if</span>(_memory_manager)</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    {</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;        <a class="code" href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;lifetime_manager());</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    }</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;}</div><div class="ttc" id="core_2_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="core_2_error_8h_source.xhtml#l00306">Error.h:306</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="afa4d42fbf7f8e750b0b06994bcdf138c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default destructor. </p>

</div>
</div>
<a class="anchor" id="af3bab8638aeb3620e242dac72a1a1fda"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a>&lt; TensorType &gt; &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prevent instances of this class from being copied (As this class contains pointers). </p>

</div>
</div>
<a class="anchor" id="adae764eb11b49e048bbd57b023caf402"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a>&lt; TensorType &gt; &amp;&amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Allow instances of this class to be moved. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8d16047fa6fdcf5f5453056cc0e1daba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void acquire </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Acquires backing memory for the whole group. </p>

<p>Implements <a class="el" href="classarm__compute_1_1_i_memory_group.xhtml#accdbc89f54447d25dfc018d38070f4ea">IMemoryGroup</a>.</p>

<p>Definition at line <a class="el" href="_memory_group_base_8h_source.xhtml#l00125">125</a> of file <a class="el" href="_memory_group_base_8h_source.xhtml">MemoryGroupBase.h</a>.</p>

<p>References <a class="el" href="core_2_error_8h_source.xhtml#l00306">ARM_COMPUTE_ERROR_ON</a>.</p>
<div class="fragment"><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;{</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    <span class="keywordflow">if</span>(!_mappings.empty())</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    {</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;        <a class="code" href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;pool_manager());</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;        _pool = _memory_manager-&gt;pool_manager()-&gt;lock_pool();</div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        _pool-&gt;acquire(_mappings);</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;    }</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;}</div><div class="ttc" id="core_2_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="core_2_error_8h_source.xhtml#l00306">Error.h:306</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="acea32c3a891a609580e97b9056b3cdf5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void finalize_memory </td>
          <td>(</td>
          <td class="paramtype">TensorType *&#160;</td>
          <td class="paramname"><em>obj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void **&#160;</td>
          <td class="paramname"><em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Finalizes memory for a given object. </p>
<dl class="section note"><dt>Note</dt><dd>Manager must not be finalized</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>Object to request memory for </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>Handle to store the memory </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of memory to allocate </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_memory_group_base_8h_source.xhtml#l00115">115</a> of file <a class="el" href="_memory_group_base_8h_source.xhtml">MemoryGroupBase.h</a>.</p>

<p>References <a class="el" href="core_2_error_8h_source.xhtml#l00306">ARM_COMPUTE_ERROR_ON</a>.</p>
<div class="fragment"><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;{</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    <span class="keywordflow">if</span>(_memory_manager)</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;    {</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;        <a class="code" href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;lifetime_manager());</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;        _memory_manager-&gt;lifetime_manager()-&gt;end_lifetime(obj, handle, <a class="code" href="hwc_8hpp.xhtml#ab2c6b258f02add8fdf4cfc7c371dd772">size</a>);</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    }</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;}</div><div class="ttc" id="core_2_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="core_2_error_8h_source.xhtml#l00306">Error.h:306</a></div></div>
<div class="ttc" id="hwc_8hpp_xhtml_ab2c6b258f02add8fdf4cfc7c371dd772"><div class="ttname"><a href="hwc_8hpp.xhtml#ab2c6b258f02add8fdf4cfc7c371dd772">size</a></div><div class="ttdeci">uint32_t size</div><div class="ttdef"><b>Definition:</b> <a href="hwc_8hpp_source.xhtml#l00286">hwc.hpp:286</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ac1f67376afb7822f262a0174ef4a3104"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void manage </td>
          <td>(</td>
          <td class="paramtype">TensorType *&#160;</td>
          <td class="paramname"><em>obj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sets a object to be managed by the given memory group. </p>
<dl class="section note"><dt>Note</dt><dd>Manager must not be finalized</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>Object to be managed </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_memory_group_base_8h_source.xhtml#l00097">97</a> of file <a class="el" href="_memory_group_base_8h_source.xhtml">MemoryGroupBase.h</a>.</p>

<p>References <a class="el" href="core_2_error_8h_source.xhtml#l00306">ARM_COMPUTE_ERROR_ON</a>.</p>
<div class="fragment"><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;{</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <span class="keywordflow">if</span>(_memory_manager)</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    {</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;        <a class="code" href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;lifetime_manager());</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        <span class="comment">// Defer registration to the first managed object</span></div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        _memory_manager-&gt;lifetime_manager()-&gt;register_group(<span class="keyword">this</span>);</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;        <span class="comment">// Associate this memory group with the tensor</span></div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        associate_memory_group(obj);</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        <span class="comment">// Start object lifetime</span></div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;        _memory_manager-&gt;lifetime_manager()-&gt;start_lifetime(obj);</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    }</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;}</div><div class="ttc" id="core_2_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="core_2_error_8h_source.xhtml#l00306">Error.h:306</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a0a9171fb9c729a0a08b1d0ff3a5e3309"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespacearm__compute.xhtml#a762c7da7319adcc433b3ac7a67e18ed5">MemoryMappings</a> &amp; mappings </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the memory mapping of the group. </p>

<p>Implements <a class="el" href="classarm__compute_1_1_i_memory_group.xhtml#aa4f0ba2c065527f486249f37350a235c">IMemoryGroup</a>.</p>

<p>Definition at line <a class="el" href="_memory_group_base_8h_source.xhtml#l00149">149</a> of file <a class="el" href="_memory_group_base_8h_source.xhtml">MemoryGroupBase.h</a>.</p>

<p>References <a class="el" href="core_2_error_8h_source.xhtml#l00238">ARM_COMPUTE_ERROR</a>.</p>
<div class="fragment"><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;{</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;    <span class="keywordflow">return</span> _mappings;</div><div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a597892bd64122315e3329751f634c20e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a>&amp; operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a>&lt; TensorType &gt; &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prevent instances of this class from being copy assigned (As this class contains pointers). </p>

</div>
</div>
<a class="anchor" id="acdceaca325dbcee01e9abebd2e4586dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a>&amp; operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a>&lt; TensorType &gt; &amp;&amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Allow instances of this class to be moved. </p>

</div>
</div>
<a class="anchor" id="ad7ed3842c3160ae4b9f51acbf4564438"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void release </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Releases backing memory of the whole group. </p>

<p>Implements <a class="el" href="classarm__compute_1_1_i_memory_group.xhtml#aab0a52fdd148a54108e7bf49287d7c47">IMemoryGroup</a>.</p>

<p>Definition at line <a class="el" href="_memory_group_base_8h_source.xhtml#l00136">136</a> of file <a class="el" href="_memory_group_base_8h_source.xhtml">MemoryGroupBase.h</a>.</p>

<p>References <a class="el" href="core_2_error_8h_source.xhtml#l00306">ARM_COMPUTE_ERROR_ON</a>, and <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml#ab9d340d42cc3ec933f5da369f1f808bb">IMemoryPool::release()</a>.</p>
<div class="fragment"><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;{</div><div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;    <span class="keywordflow">if</span>(_pool != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;    {</div><div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;        <a class="code" href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;pool_manager());</div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;        <a class="code" href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(_mappings.empty());</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;        _pool-&gt;<a class="code" href="classarm__compute_1_1_i_memory_pool.xhtml#ab9d340d42cc3ec933f5da369f1f808bb">release</a>(_mappings);</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;        _memory_manager-&gt;pool_manager()-&gt;unlock_pool(_pool);</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;        _pool = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;    }</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;}</div><div class="ttc" id="core_2_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="core_2_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="core_2_error_8h_source.xhtml#l00306">Error.h:306</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_pool_xhtml_ab9d340d42cc3ec933f5da369f1f808bb"><div class="ttname"><a href="classarm__compute_1_1_i_memory_pool.xhtml#ab9d340d42cc3ec933f5da369f1f808bb">arm_compute::IMemoryPool::release</a></div><div class="ttdeci">virtual void release(MemoryMappings &amp;handles)=0</div><div class="ttdoc">Releases a memory block. </div></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>arm_compute/runtime/CL/<a class="el" href="_c_l_tensor_allocator_8h_source.xhtml">CLTensorAllocator.h</a></li>
<li>arm_compute/runtime/<a class="el" href="_memory_group_base_8h_source.xhtml">MemoryGroupBase.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_memory_group_base.xhtml">MemoryGroupBase</a></li>
    <li class="footer">Generated on Fri Mar 2 2018 12:37:58 for Compute Library by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
